home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tex / macros / source / contrib / supported / xypic / src / readme < prev    next >
Text File  |  1995-03-15  |  8KB  |  222 lines
  1. -*-text-*- $Id: README,v 2.12 1994/10/25 11:34:25 kris Exp $
  2.  
  3.       =========================================================
  4.       READ ME FIRST: Xy-pic diagram typesetting package SOURCES
  5.       =========================================================
  6.  
  7. Welcome to the source distribution of the Xy-pic macros for
  8. typesetting diagrams!  Below you will find the following sections:
  9.  
  10.   -1- License information
  11.   -2- Making the package and manual from sources
  12.   -3- Bugs & comments
  13.   -4- Distribution log
  14.  
  15. Please see the file `TRAILER' for a summary of features and how you
  16. can obtain Xy-pic if all you got is this file, and the file `INSTALL'
  17. if you have retrieved the `ready-to-use' package.
  18.  
  19. ----------------------------------------------------------------------
  20.   -1- LICENSE INFORMATION
  21. ----------------------------------------------------------------------
  22.  
  23. The Xy-pic package is licensed under `GNU CopyLeft':
  24.  
  25.   Xy-pic: Typesetting graphs and diagrams with TeX.
  26.   Copyright (c) 1991-1994  Kristoffer H. Rose  <kris@diku.dk>
  27.  
  28.   The Xy-pic macro package is free software; you can redistribute it
  29.   and/or modify it under the terms of the GNU General Public License
  30.   as published by the Free Software Foundation; either version 2 of
  31.   the License, or (at your option) any later version.
  32.  
  33.   The Xy-pic macro package is distributed in the hope that it will be
  34.   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  35.   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  36.   General Public License for more details.
  37.  
  38.   You should have received a copy of the GNU General Public License
  39.   along with this package; if not, write to the Free Software
  40.   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  41.  
  42. (Some options may be copyright by other people but the conditions
  43. remain the same).
  44.  
  45. The full text of the GNU General Public License is supplied with
  46. Xy-pic in the file `COPYING'.
  47.  
  48. ----------------------------------------------------------------------
  49.   -2- MAKING THE PACKAGE AND MANUAL FROM SOURCES
  50. ----------------------------------------------------------------------
  51.  
  52. This section describes how to make the Xy-pic package from sources on
  53. a un*x system.  Making Xy-pic requires use (and some knowledge) of
  54. several standard un*x utilities; furthermore the installation uses
  55. both TeX (with the LaTeX format) and METAFONT (with the plain base).
  56. If you do not have a un*x system then you are best adviced to get the
  57. `ready to run' package and install it as described in `INSTALL'.
  58.  
  59. Generation and installation procedure:
  60.  
  61. 1. First make sure that you have a separate directory `src' which
  62.    contains all the files of the distribution (including this file).
  63.    The file `MANIFEST' contains a list of the files.
  64.  
  65. 2. Next you should edit the `Configuration section' of `Makefile' to
  66.    fit the configuration of your system by following the directions
  67.    given there.
  68.  
  69.    When you have configured everything then just do
  70.  
  71.     make
  72.  
  73.    which should generate all the files needed to use the package.
  74.  
  75. 3. You can test the newly generated system by typesetting the User's
  76.    Guide which you probably want for reference anyway: do
  77.  
  78.     make guide
  79.  
  80.    which should produce a file `xyguide.dvi' by running LaTeX several
  81.    times and BibTeX once.
  82.  
  83. 4. If possible it is a good idea to try to preview the User's Guide
  84.    (in whatever way you do on your system) at this point.  This is
  85.    slightly difficult because it uses the Xy-pic fonts which you
  86.    haven't installed yet, so the previewer should be instructed to
  87.    look in the current directory before looking in the system font
  88.    directories.  The following show how to do this for the most common
  89.    previewer (on un*x systems with X windows) and might work for you:
  90.  
  91.     env XDVIFONTS=.: xdvi xyguide.dvi
  92.  
  93. 5. You should then install the package by ensuring that the install
  94.    directories in `Makefile' are setup correctly and do
  95.  
  96.     make install
  97.  
  98.    This will replace exisiting `xypic.tex' and `xypic.sty' files with
  99.    the new (compatibility mode) ones; the old ones will remain
  100.    available with an `.orig' suffix.
  101.  
  102. 6. You can typeset the entire manual with
  103.  
  104.     make manual
  105.  
  106.    to create both files `xyguide.dvi' and `xyrefer.dvi'; they can be
  107.    installed in the TEXDOC directory with the command
  108.  
  109.     make install.manual
  110.  
  111. 7. You can build format files by the commands
  112.  
  113.     make xytex.fmt
  114.     make xylatex.fmt
  115.  
  116.    (the latter requires the new standard LaTeX release aka LaTeX2e).
  117.    These assume that the files `plain.tex' and `latex.ltx' are
  118.    available in the TeX search path; also you have to install the
  119.    format files in the appropriate place yourself.
  120.  
  121. That is all.
  122.  
  123. ----------------------------------------------------------------------
  124.   -3- BUGS & COMMENTS
  125. ----------------------------------------------------------------------
  126.  
  127. I will appreciate reports on any problems you may encounter and
  128. opinions you have on how the usefulness of Xy-pic can be improved.
  129. Please report using either
  130.  
  131.   Electronic mail (Internet): kris@diku.dk    [preferred]
  132.  
  133.   Paper mail:    Kristoffer H. Rose
  134.         DIKU, University of Copenhagen
  135.         Universitetsparken 1
  136.         DK--2100 K{\o}benhavn {\O}
  137.         DENMARK
  138.  
  139.   Fax        +45 35321401 att. K.Rose / L.Wiese
  140.  
  141. You can always get the latest news of Xy-pic from computers connected
  142. to the Internet by opening the Xy-pic World Wide Web page:
  143.  
  144.   W3 URL:    http://www.diku.dk/users/kris/Xy-pic.html
  145.  
  146. ----------------------------------------------------------------------
  147.   -4- DISTRIBUTION LOG
  148. ----------------------------------------------------------------------
  149.  
  150. The following versions have been distributed publicly:
  151.  
  152. $Log: README,v $
  153. Revision 2.12  1994/10/25  11:34:25  kris
  154. Interim release just before v3 [works with AMS-LaTeX 1.2]...
  155.  
  156. Revision 2.11  1994/07/05  10:37:32  kris
  157. Third 3beta release [bug fixes].
  158. Experimental graph feature included (for ECCT-94 presentation).
  159.  
  160. Revision 2.10  1994/06/15  12:59:44  kris
  161. Second 3beta release [bug fixes].
  162.  
  163. Revision 2.8  1994/04/11  09:31:09  kris
  164. Second (bug fix) 3alpha release [corrected].
  165.  
  166. Revision 2.7  1994/03/08  02:06:01  kris
  167. Release 3alpha.
  168.  
  169. MAJOR REWRITE of distribution to prepare for Xy-pic 3 functionality.
  170. Curve extension code contributed by Ross Moore <ross@mpce.mq.edu.au>;
  171. support funding from MURG, ARC, and equipment from DEC.
  172.  
  173. Revision 2.6  1992/06/24  01:23:34  kris
  174. Added `hook' tips using new font xyqc10.
  175. Added new POSitions: * and !.
  176. Added triple lines \Ssolid, \Ddashed, \Ddotted, and companion \Ttip.
  177. Reorganised manual.
  178.  
  179. Revision 2.5  1992/02/24  03:30:54  kris
  180. Fixed bugs in \Direction calculation logic...
  181. Added (FACTOR) to \rotate to allow arbitrary rotation.
  182. ` intermediate points now accept an optional /RADIUS argument.
  183. Added \Tip with wide tip.
  184.  
  185. Revision 2.4  1992/01/22  02:15:10  kris
  186. Fixed bugs [with thanks]:
  187. \\ works with AMS-LaTeX: don't use \Let@ [Werner Struckmann/Darrel Hankerson]
  188. No spurious arrow heads with LaTeX: \pit now undefined [Werner Struckmann]
  189. \Solid works: sets \Density [Dave Bowen]
  190. Short diagonal lines work...major rewrite of \connectv@ [Eric Domenjoud]
  191.  
  192. Revision 2.3  1992/01/10  21:38:27  kris
  193. Several bugs fixed [with thanks]:
  194. The \ddtoX and \uutoX arrows were interchanged [Nico Verwer].
  195. Some diagonal lines were wrong [Eric Domenjoud].
  196. AMS-LaTeX users had name clash problems [Werner Struckmann].
  197. The installation instructions in the Makefile were buggy [Leen Torenvliet].
  198.  
  199. Revision 2.2  1992/01/09 04:05:40  kris
  200. Patched to fix problem with \text and support AMS-LaTeX.
  201.  
  202. Revision 2.1  1992/01/02 14:54:07  kris
  203. Release version.
  204.  
  205. Revision 1.40  1991/12/17 04:53:23 kris
  206. Version distributed as `final draft' on Usenet.
  207.  
  208. ----------------------------------------------------------------------
  209.  
  210. This is the end of the source README.  I hope you will enjoy Xy-pic!
  211.  
  212. ----------------------------------------------------------------------
  213.  
  214.           Kristoffer H{\o}gsbro ROSE  <kris@diku.dk>
  215.  
  216.      DIKU, Universitetsparken 1, 2100 K{\o}benhavn {\O}, DANMARK
  217.      Phones: +45 35321400 direct: +45 35321420 fax: +45 35321401
  218.  
  219.     World Wide Web <URL: http://www.diku.dk/users/kris/>
  220.  
  221. ----------------------------------------------------------------------
  222.